Get deal leads list.
# 1. Tổng quan
- Action URL:
/api/v1/deals/leads - Đặc tả chi tiết: Swagger Link (opens new window)
- Tính năng này cho phép trả về danh sách các Lead gắn trong itemList của một Opportunity (Deal).
- Chỉ áp dụng cho tài khoản Agency có quyền truy cập hợp lệ và cung cấp đúng thông tin xác thực trong header (token, password, account).
# 2. Hướng dẫn
- Bước 1: Xây dựng request với đầy đủ header và body
- Bước 2: Gửi request POST tới Action URL.
- Bước 3: Nhận về response chứa danh sách invoices.
# 3. Request
# 3.1 Ví dụ
{
"dealId": "6898de48c1b560cbf"
}
# 3.2 Cấu trúc dữ liệu Resquest
| Thuộc tính | Bắt buộc | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|---|
| dealId | Có | String | Mã định danh của deal/opportunity cần lấy invoices | "6898de48c1b560cbf" |
# 4. Response
# 4.1 Ví dụ
{
"StatusCode": 200,
"Timestamp": "2:32:36 AM",
"Path": "/api/v1/deals/leads",
"Message": "Lấy leads thành công",
"Data": {
"total": 1,
"list": [
{
"leadId": "6898de4848c4e9e2c",
"leadName": "HOANG LE",
"ticketNumber": "9994568959207"
}
]
},
"Errors": null,
"RequestId": "req_1760581956454_9txlw5tbq",
"TotalDuration": 524
}
# 4.2 Bảng mô tả trường (Response)
| Thuộc tính | Bắt buộc | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|---|
| StatusCode | có | String | Tình trạng tạo sub | |
| Timestamp | có | String | Thời gian xử lý request | |
| Path | có | String | ||
| Message | có | String | Thông báo kết quả | |
| Errors | có | String | Thông tin lỗi nếu có | |
| RequestId | có | String | Mã định danh request | |
| TotalDuration | có | string | Thời gian xử lý (ms) | |
| Data | có | object | Đối tượng chứa dữ liệu chính trả về từ API. | |
| total | có | integer | Tổng số lượng lead được tìm thấy. | |
| list | có | array | Danh sách các lead (mỗi phần tử là một đối tượng lead). | |
| leadId | có | string | Mã định danh duy nhất của lead. | |
| leadName | có | string | Tên của lead | |
| ticketNumber | không | string | Số vé hoặc mã tham chiếu (nếu có). |
# Bảng mô tả mã tình trạng tạo sub
| Mã | Ý nghĩa |
|---|---|
| 200 | Thành công |
| 400 | Dữ liệu không hợp lệ |
| 401 | Không có quyền tạo sub |
| 404 | DealId không tồn tại trong hệ thống |
| 500 | Lỗi từ phía server |